/**
 * Copyright (C) 2002-2015   The FreeCol Team
 * <p>
 * This file is part of FreeCol.
 * <p>
 * FreeCol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * <p>
 * FreeCol is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.common.option;

import net.sf.freecol.common.model.AbstractUnit;
import net.sf.freecol.common.model.Specification;


/**
 * Represents an option where the valid choice is a list of
 * AbstractUnits, e.g. the units of the REF.
 */
public class UnitListOption extends ListOption< AbstractUnit >
{

    /**
     * Creates a new <code>UnitListOption</code>.
     *
     * @param specification The <code>Specification</code> to refer to.
     */
    public UnitListOption( Specification specification )
    {
        super( specification );
    }

    /**
     * Creates a new <code>UnitListOption</code>.
     *
     * @param id The object identifier.
     * @param specification The <code>Specification</code> to refer to.
     */
    public UnitListOption( String id, Specification specification )
    {
        super( id, specification );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public UnitListOption clone( )
    {
        UnitListOption ret = new UnitListOption( getId( ), getSpecification( ) );
        ret.setValues( this );
        return ret;
    }


    // Serialization

    /**
     * {@inheritDoc}
     */
    @Override
    public String getXMLTagName( ) { return getXMLElementTagName( ); }

    /**
     * Gets the tag name of the root element representing this object.
     *
     * @return "unitListOption".
     */
    public static String getXMLElementTagName( )
    {
        return "unitListOption";
    }
}
